Skip to content

Creating a new Custom Task Status

Request

Adds a new custom status to a task status set.

This endpoint returns structured Custom Task Status objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the custom_task_statuses top-level JSON key. Please see our Response Format section for more information.

Query
includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • task_status_set (StatusSet) - Retrieves the task status set the custom status is in. The response will include task_status_set_id, which references the data in the task_status_sets top-level key.
Bodyapplication/jsonrequired
custom_task_statusobject
{
  "custom_task_status": {
    "status": "string",
    "category": "string",
    "status_set_id": 0
  }
}

Responses

Custom Task Status has been created.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
task_status_setsobject
custom_task_statusesobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "task_status_sets": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "custom_task_status_ids": [
        "string"
      ],
      "name": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "custom_task_status_ids": [
        "string"
      ],
      "name": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "custom_task_statuses": {
    "property1": {
      "category": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "position": 0,
      "status": "string",
      "status_set_id": 0,
      "task_status_set_id": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "category": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "position": 0,
      "status": "string",
      "status_set_id": 0,
      "task_status_set_id": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  }
}